<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../../../print.css" type="text/css" media="print">
<meta content="SequenceEventWatcher,net.digitalprimates.flex2.unit.sequence.SequenceEventWatcher,target,eventName,passThroughData,eventHandler" name="keywords">
<title>net.digitalprimates.flex2.unit.sequence.SequenceEventWatcher</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'SequenceEventWatcher - AS3 FlexTest';
				var baseRef = '../../../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">Unit and Integration Framework for Actionscript 3 and Flex 2 and 3</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../../../all-classes.html')" href="../../../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../../all-classes.html')" href="../../../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../../index-list.html')" href="../../../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../../../index.html?net/digitalprimates/flex2/unit/sequence/SequenceEventWatcher.html&amp;net/digitalprimates/flex2/unit/sequence/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;SequenceEventWatcher</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class SequenceEventWatcher"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">net.digitalprimates.flex2.unit.sequence</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class SequenceEventWatcher</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Implements</td><td><a href="ISequenceVerify.html">ISequenceVerify</a></td>
</tr>
</table>
<p></p> 
  The SequencerEventWatcher class is used by the TestCase sequence code to indicate
  that a sequence has ended and that we need to monitor a specific object for an 
  event to occur.
  
  Once that event occurs, we call the eventHandler and pass it the event and 
  passThroughData. 
  <p></p>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#eventHandler">eventHandler</a> : Function<div class="summaryTableDescription">[read-only] 
   <p>
   A reference to the event handler that should be called if the specified 
   eventName occurs on the target before the timeout in the previous sequence 
   step is reached.</div>
</td><td class="summaryTableOwnerCol">SequenceEventWatcher</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#eventName">eventName</a> : String<div class="summaryTableDescription">[read-only] 
   Name of the event that will be broadcast by the broadcaster.</div>
</td><td class="summaryTableOwnerCol">SequenceEventWatcher</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#passThroughData">passThroughData</a> : Object<div class="summaryTableDescription">[read-only] 
   A generic object that is optionally provided by the developer when 
   starting a new asynchronous operation.</div>
</td><td class="summaryTableOwnerCol">SequenceEventWatcher</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#target">target</a> : IEventDispatcher<div class="summaryTableDescription">[read-only] 
   The object expected to broadcast the event named in the eventName 
   property.</div>
</td><td class="summaryTableOwnerCol">SequenceEventWatcher</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#SequenceEventWatcher()">SequenceEventWatcher</a>(broadcaster:IEventDispatcher, eventName:String, eventHandler:Function, passThroughData:Object = null)</div>
<div class="summaryTableDescription"> 
   Constructor.</div>
</td><td class="summaryTableOwnerCol">SequenceEventWatcher</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="eventHandler"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">eventHandler</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>eventHandler:Function</code>&nbsp;&nbsp;[read-only]<p> 
   </p><p>
   A reference to the event handler that should be called if the specified 
   eventName occurs on the target before the timeout in the previous sequence 
   step is reached. </p>
   
   <p>
   The handler is expected to have the follow signature:</p>
   
   <p><code>
   public function handleEvent( event:Event, passThroughData:Object ):void {
   }</code></p>
   
   <p>
   The first parameter is the original event object.
   The second parameter is a generic object that can optionally be provided by 
   the developer when creating a new sequence.
   <span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get eventHandler():Function</code>
<br>
</div>
<a name="eventName"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">eventName</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>eventName:String</code>&nbsp;&nbsp;[read-only]<p> 
   Name of the event that will be broadcast by the broadcaster. 
   
   When this event is broadcast, the TestCase sequence code calls 
   the eventHandler function. 
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get eventName():String</code>
<br>
</div>
<a name="passThroughData"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">passThroughData</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>passThroughData:Object</code>&nbsp;&nbsp;[read-only]<p> 
   A generic object that is optionally provided by the developer when 
   starting a new asynchronous operation.
   
   This generic object is passed to the eventHandler function if it is 
   called. 
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get passThroughData():Object</code>
<br>
</div>
<a name="target"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">target</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>target:IEventDispatcher</code>&nbsp;&nbsp;[read-only]<p> 
   The object expected to broadcast the event named in the eventName 
   property. 
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get target():IEventDispatcher</code>
<br>
</div>
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="SequenceEventWatcher()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">SequenceEventWatcher</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function SequenceEventWatcher(broadcaster:IEventDispatcher, eventName:String, eventHandler:Function, passThroughData:Object = null)</code><p> 
   Constructor.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">broadcaster</span>:IEventDispatcher</code> &mdash; The IEventDispatcher expected to broadcast an event. 
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">eventName</span>:String</code> &mdash; The eventName that will be broadcast. 
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">eventHandler</span>:Function</code> &mdash; The eventHandler that should be called when the event occurs.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">passThroughData</span>:Object</code> (default = <code>null</code>)<code></code> &mdash; Optional parameter, specified by the developer. 
   </td>
</tr>
</table>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright">Copyright 2007 Digital Primates IT Consulting Group</center>
</div>
</body>
</html>
<!--Copyright 2007 Digital Primates IT Consulting Group-->
